Skip to content

chore(claude): add pkg-pr-new preview deploy lookup instructions#4767

Closed
NathanFlurry wants to merge 1 commit into04-24-refactor_pegboard_gateway2_hibernation_inflight_statefrom
04-24-chore_claude_add_pkg-pr-new_preview_deploy_lookup_instructions
Closed

chore(claude): add pkg-pr-new preview deploy lookup instructions#4767
NathanFlurry wants to merge 1 commit into04-24-refactor_pegboard_gateway2_hibernation_inflight_statefrom
04-24-chore_claude_add_pkg-pr-new_preview_deploy_lookup_instructions

Conversation

@NathanFlurry
Copy link
Copy Markdown
Member

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

This was referenced Apr 24, 2026
Copy link
Copy Markdown
Member Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@claude
Copy link
Copy Markdown

claude Bot commented Apr 24, 2026

Code Review

Overview

This is a minimal documentation-only change that adds a one-line instruction to CLAUDE.md explaining how to find the preview deploy for a PR using the pkg-pr-new bot.


Analysis

What it does:

  • Adds a single bullet point under the Git + PRs section of CLAUDE.md
  • Explains the correct workflow for locating pkg-pr-new preview deploys, including:
    • How to read the bot comment via GitHub API
    • How to find the Publish check URL
    • Two important gotchas to avoid

Code Quality / Style:

  • Follows CLAUDE.md conventions — single bullet point, concise instruction, no paragraphs. ✓
  • Placed logically under the Git + PRs section where it's contextually relevant. ✓
  • Uses exact gh CLI commands, making it actionable rather than vague. ✓

Content Accuracy:

The two gotchas captured are well-reasoned and worth documenting:

  1. pkg-pr-new tags its synthesized merge commit, not the branch tip — this is a real footgun that would cause version mismatches if naively using gh pr view head SHA.
  2. Only changed workspaces are published — transitive @rivetkit/* dependencies may be missing, which is critical context for anyone using preview deploys to test inter-package behavior.

Minor Suggestions:

  • The jq filter uses test("github-actions"; "i") — this works but may match unrelated GitHub Actions comments if other workflows also post to the PR. A tighter filter (e.g. matching on .body | contains("pkg.pr.new")) would be more precise, but this is a low-risk documentation note, not production code.
  • Optionally, "read the pkg-pr-new bot comment" could be clarified to "read the github-actions bot comment left by pkg-pr-new" to make the login filter less surprising to first-time readers.

Summary

Well-targeted, minimal CLAUDE.md addition that captures non-obvious operational knowledge about pkg-pr-new behavior. Follows project conventions and will save future agents/contributors from real confusion. No blocking issues.

Verdict: LGTM with minor optional suggestions.

@github-actions
Copy link
Copy Markdown
Contributor

Preview packages published to npm

Install with:

npm install rivetkit@pr-4767

All packages published as 0.0.0-pr.4767.f478764 with tag pr-4767.

Engine binary is shipped via @rivetkit/engine-cli on linux-x64-musl, linux-arm64-musl, darwin-x64, and darwin-arm64. Windows users should use the release installer or set RIVET_ENGINE_BINARY.

Docker images:

docker pull rivetdev/engine:slim-f478764
docker pull rivetdev/engine:full-f478764
Individual packages
npm install rivetkit@pr-4767
npm install @rivetkit/react@pr-4767
npm install @rivetkit/rivetkit-napi@pr-4767
npm install @rivetkit/workflow-engine@pr-4767

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant